/********************************************************************************
 * Copyright 2009 The Robotics Group, The Maersk Mc-Kinney Moller Institute,
 * Faculty of Engineering, University of Southern Denmark
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ********************************************************************************/

#ifndef RW_LOADERS_PPMLOADER_HPP
#define RW_LOADERS_PPMLOADER_HPP

/**
 * @file PPMLoader.hpp
 */

#include "../ImageLoader.hpp"

#include <rw/sensor/Image.hpp>

namespace rw { namespace loaders {

    /** @addtogroup loaders */
    /*@{*/

    /**
     * @brief Loads images in Portable Pixel Map (PPM) format.
     *
     * The image format is quite simple and editors like Gimp and Photoshop are
     * able to view and edit this format.
     */
    class PPMLoader : public ImageLoader
    {
      public:
        //! @copydoc ImageLoader::loadImage
        rw::sensor::Image::Ptr loadImage (const std::string& filename);

        //! @copydoc ImageLoader::getImageFormats
        std::vector< std::string > getImageFormats ();

        /**
         * @param filename [in] name of the file that is to be loaded.
         * @return if loaded successfully a pointer to the image is returned else NULL
         */
        static rw::sensor::Image::Ptr load (const std::string& filename);

      private:
    };
    /*@}*/
}}    // namespace rw::loaders

#endif /*RW_LOADERS_PPMLOADER_HPP*/
